﻿namespace DotNetStar.OpenSDK
{
    /// <summary>
    /// 提供一个默认的 api 响应对象。
    /// </summary>
    public class ApiResponse
    {
        /// <summary>
        /// 初始化 <see cref="ApiResponse"/> 类的新实例。
        /// </summary>
        protected ApiResponse()
        {
        }

        /// <summary>
        /// 获取开放平台提供的 api 返回代码。
        /// </summary>
        public virtual string Code { get; set; }

        /// <summary>
        /// 获取开放平台提供的 api 返回消息。
        /// </summary>
        public virtual string Message { get; set; }

        /// <summary>
        /// 获取一个布尔值，表示响应的结果是否成功。
        /// </summary>
        /// <value>
        ///  当 <see cref="Code"/> 是空字符串时为 <c>true</c>;否则是 <c>false</c>。
        /// </value>
        public virtual bool IsSucceed => string.IsNullOrEmpty(this.Code);
    }
}
